Skip to main content
List Organisational Units

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit
integer
default:100

The maximal number of entities returned, ordered by the last_updated field and external_id.

Required range: 1 <= x <= 200
Example:

50

offset
integer
default:0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x >= 0
parent_id
string

This parameter can be used to only include Organisational Units with the specified parent_id as their direct parent. If parent_id="null", only root Organisational Units are included. If the parameter is not set, all entities will be included.

Example:

"c3903505-eb84-42dc-a79f-5d8b1fe897b7"

Response

OK

count
integer
required

Total number of Organisational Unit objects stored in the system. If filtered by parent_id, only the matching units are counted.

Required range: x >= 0
Example:

3

results
Organisational Unit · object[]
required

Subset of Organisational Unit starting from offset up to offset + limit.

Example: